/*
** $Id: lstate.h,v 2.133.1.1 2017/04/19 17:39:34 roberto Exp $
** Global State
** See Copyright Notice in lua.h
*/

#ifndef lstate_h
#define lstate_h

#include "lua.h"

#include "lobject.h"
#include "ltm.h"
#include "lzio.h"


/*

** Some notes about garbage-collected objects: All objects in Lua must
** be kept somehow accessible until being freed, so all objects always
** belong to one (and only one) of these lists, using field 'next' of
** the 'CommonHeader' for the link:
**
** 'allgc': all objects not marked for finalization;
** 'finobj': all objects marked for finalization;
** 'tobefnz': all objects ready to be finalized;
** 'fixedgc': all objects that are not to be collected (currently
** only small strings, such as reserved words).
**
** Moreover, there is another set of lists that control gray objects.
** These lists are linked by fields 'gclist'. (All objects that
** can become gray have such a field. The field is not the same
** in all objects, but it always has this name.)  Any gray object
** must belong to one of these lists, and all objects in these lists
** must be gray:
**
** 'gray': regular gray objects, still waiting to be visited.
** 'grayagain': objects that must be revisited at the atomic phase.
**   That includes
**   - black objects got in a write barrier;
**   - all kinds of weak tables during propagation phase;
**   - all threads.
** 'weak': tables with weak values to be cleared;
** 'ephemeron': ephemeron tables with white->white entries;
** 'allweak': tables with weak keys and/or weak values to be cleared.
** The last three lists are used only during the atomic phase.

*/


struct lua_longjmp;  /* defined in ldo.c */


/*
** Atomic type (relative to signals) to better ensure that 'lua_sethook'
** is thread safe
*/
#if !defined(l_signalT)

#include <signal.h>

#define l_signalT  sig_atomic_t
#endif


/* extra stack space to handle TM calls and some other extras */
#define EXTRA_STACK   5


#define BASIC_STACK_SIZE        (2*LUA_MINSTACK)


/* kinds of Garbage Collection */
#define KGC_NORMAL  0
#define KGC_EMERGENCY  1  /* gc was forced by an allocation failure */


typedef struct stringtable {
    TString **hash;
    int nuse;  /* number of elements */
    int size;
} stringtable;


/**
 * 表示调用信息的结构体。
 * 当一个线程挂起时，'func' 会被调整为假装栈顶函数仅包含挂起时的值；
 * 此时，实际的 'func' 值会被保存在 'extra' 字段中。
 * 当一个函数通过 continuation 调用另一个函数时，'extra' 会保存函数索引，
 * 以便在发生错误时，continuation 函数可以在正确的栈顶被调用。
 *
 * @field func 函数在栈中的索引。
 * @field top 该函数的栈顶。
 * @field previous, next 动态调用链的前驱和后继指针。
 * @field u.l 仅用于 Lua 函数的字段：
 *   - base 该函数的基地址。
 *   - savedpc 保存的程序计数器。
 * @field u.c 仅用于 C 函数的字段：
 *   - k 挂起时的 continuation 函数。
 *   - old_errfunc 旧的错误处理函数。
 *   - ctx 挂起时的上下文信息。
 * @field extra 额外的信息，用于保存实际的 'func' 值或函数索引。
 * @field nresults 该函数预期的返回值数量。
 * @field callstatus 调用状态标志。
 */
/*
** Information about a call.
** When a thread yields, 'func' is adjusted to pretend that the
** top function has only the yielded values in its stack; in that
** case, the actual 'func' value is saved in field 'extra'.
** When a function calls another with a continuation, 'extra' keeps
** the function index so that, in case of errors, the continuation
** function can be called with the correct top.
*/
typedef struct CallInfo {
    StkId func;  /* function index in the stack */
    StkId top;  /* top for this function */
    struct CallInfo *previous, *next;  /* dynamic call link */
    union {
        struct {  /* only for Lua functions */
            StkId base;  /* base for this function */
            const Instruction *savedpc;
        } l;
        struct {  /* only for C functions */
            lua_KFunction k;  /* continuation in case of yields */
            ptrdiff_t old_errfunc;
            lua_KContext ctx;  /* context info. in case of yields */
        } c;
    } u;
    ptrdiff_t extra;
    short nresults;  /* expected number of results from this function */
    unsigned short callstatus;
} CallInfo;


/*
** Bits in CallInfo status
*/
#define CIST_OAH  (1<<0)  /* original value of 'allowhook' */
#define CIST_LUA  (1<<1)  /* call is running a Lua function */
#define CIST_HOOKED  (1<<2)  /* call is running a debug hook */
#define CIST_FRESH  (1<<3)  /* call is running on a fresh invocation
                                   of luaV_execute */
#define CIST_YPCALL  (1<<4)  /* call is a yieldable protected call */
#define CIST_TAIL  (1<<5)  /* call was tail called */
#define CIST_HOOKYIELD  (1<<6)  /* last hook called yielded */
#define CIST_LEQ  (1<<7)  /* using __lt for __le */
#define CIST_FIN  (1<<8)  /* call is running a finalizer */

#define isLua(ci)  ((ci)->callstatus & CIST_LUA)

/* assume that CIST_OAH has offset 0 and that 'v' is strictly 0/1 */
#define setoah(st, v)  ((st) = ((st) & ~CIST_OAH) | (v))
#define getoah(st)  ((st) & CIST_OAH)


/**
 * 全局状态结构体，由当前 Lua 状态的所有线程共享。
 *
 * 该结构体包含 Lua 虚拟机的全局状态信息，包括内存管理、垃圾回收、字符串表、注册表等核心组件。
 *
 * @field frealloc      内存重新分配函数指针，用于动态内存管理。
 * @field ud            传递给 `frealloc` 的辅助数据。
 * @field totalbytes    当前已分配的内存总字节数（减去 GC 债务）。
 * @field GCdebt        尚未被垃圾回收器补偿的已分配内存字节数。
 * @field GCmemtrav     垃圾回收器遍历的内存字节数。
 * @field GCestimate    非垃圾内存使用量的估计值。
 * @field strt          字符串哈希表，用于存储所有字符串。
 * @field l_registry    全局注册表，存储 Lua 的全局数据。
 * @field seed          随机化哈希种子。
 * @field currentwhite  当前白色标记（用于垃圾回收）。
 * @field gcstate       垃圾回收器的当前状态。
 * @field gckind        垃圾回收器的类型。
 * @field gcrunning     标记垃圾回收器是否正在运行。
 * @field allgc         所有可回收对象的链表。
 * @field sweepgc       当前正在清理的对象链表位置。
 * @field finobj        带有终结器的可回收对象链表。
 * @field gray          灰色对象链表（待处理对象）。
 * @field grayagain     需要原子遍历的对象链表。
 * @field weak          弱值表的链表。
 * @field ephemeron     弱键表的链表。
 * @field allweak       全弱表的链表。
 * @field tobefnz       待垃圾回收的用户数据链表。
 * @field fixedgc       不会被回收的对象链表。
 * @field twups         带有开放上值的线程链表。
 * @field gcfinnum      每个垃圾回收步骤中需要调用的终结器数量。
 * @field gcpause       连续垃圾回收之间的暂停大小。
 * @field gcstepmul     垃圾回收的“粒度”。
 * @field panic         在未保护错误时调用的函数。
 * @field mainthread    主线程。
 * @field version       指向版本号的指针。
 * @field memerrmsg     内存错误消息字符串。
 * @field tmname        标签方法名称数组。
 * @field mt            基本类型的元表数组。
 * @field strcache      API 中字符串的缓存。
 */
/*
** 'global state', shared by all threads of this state
*/
typedef struct global_State {
    lua_Alloc frealloc;  /* function to reallocate memory */
    void *ud;         /* auxiliary data to 'frealloc' */
    l_mem totalbytes;  /* number of bytes currently allocated - GCdebt */
    l_mem GCdebt;  /* bytes allocated not yet compensated by the collector */
    lu_mem GCmemtrav;  /* memory traversed by the GC */
    lu_mem GCestimate;  /* an estimate of the non-garbage memory in use */
    stringtable strt;  /* hash table for strings */
    TValue l_registry;
    unsigned int seed;  /* randomized seed for hashes */
    lu_byte currentwhite;
    lu_byte gcstate;  /* state of garbage collector */
    lu_byte gckind;  /* kind of GC running */
    lu_byte gcrunning;  /* true if GC is running */
    GCObject *allgc;  /* list of all collectable objects */
    GCObject **sweepgc;  /* current position of sweep in list */
    GCObject *finobj;  /* list of collectable objects with finalizers */
    GCObject *gray;  /* list of gray objects */
    GCObject *grayagain;  /* list of objects to be traversed atomically */
    GCObject *weak;  /* list of tables with weak values */
    GCObject *ephemeron;  /*蜉蝣 list of ephemeron tables (weak keys) */
    GCObject *allweak;  /* list of all-weak tables */
    GCObject *tobefnz;  /* list of userdata to be GC */
    GCObject *fixedgc;  /* list of objects not to be collected */
    struct lua_State *twups;  /* list of threads with open upvalues */
    unsigned int gcfinnum;  /* number of finalizers to call in each GC step */
    int gcpause;  /* size of pause between successive GCs */
    int gcstepmul;  /* GC 'granularity' */
    lua_CFunction panic;  /* to be called in unprotected errors */
    struct lua_State *mainthread;
    const lua_Number *version;  /* pointer to version number */
    TString *memerrmsg;  /* memory-error message */
    TString *tmname[TM_N];  /* 标签方法(元方法)名称数组 array with tag-method names */
    struct Table *mt[LUA_NUMTAGS];  /* metatables for basic types */
    TString *strcache[STRCACHE_N][STRCACHE_M];  /* cache for strings in API */
} global_State;


/*
** 'per thread' state
*/
/**
 * Lua 状态机结构体，用于表示一个 Lua 线程或协程的状态。
 *
 * @field nci            当前调用信息列表中的条目数量。
 * @field status         Lua 状态机的当前状态（如运行、挂起等）。
 * @field top            栈中第一个空闲槽的指针。
 * @field l_G            指向全局状态的指针。
 * @field ci             当前函数的调用信息。
 * @field oldpc          最后追踪的程序计数器（pc）值。
 * @field stack_last     栈中最后一个空闲槽的指针。
 * @field stack          栈的基地址。
 * @field openupval      当前栈中开放的上值（upvalue）列表。
 * @field gclist         垃圾回收链表中的下一个对象。
 * @field twups          拥有开放上值的线程列表。
 * @field errorJmp       当前错误恢复点的长跳转信息。
 * @field base_ci        第一层调用信息（C 调用 Lua 时使用）。
 * @field hook           当前设置的钩子函数。
 * @field errfunc        当前错误处理函数的栈索引。
 * @field stacksize      栈的大小。
 * @field basehookcount  钩子计数器的基准值。
 * @field hookcount      当前钩子计数器的值。
 * @field nny            栈中不可挂起的调用数量。
 * @field nCcalls        嵌套的 C 调用数量。
 * @field hookmask       钩子掩码，用于控制钩子触发条件。
 * @field allowhook      是否允许钩子触发的标志。
 */
struct lua_State {
    CommonHeader;
    unsigned short nci;  /* number of items in 'ci' list */
    lu_byte status;
    StkId top;  /* first free slot in the stack */
    global_State *l_G;
    CallInfo *ci;  /* call info for current function */
    const Instruction *oldpc;  /* last pc traced */
    StkId stack_last;  /* last free slot in the stack */
    StkId stack;  /* stack base */
    UpVal *openupval;  /* list of open upvalues in this stack */
    GCObject *gclist;
    struct lua_State *twups;  /* list of threads with open upvalues */
    struct lua_longjmp *errorJmp;  /* current error recover point */
    CallInfo base_ci;  /* CallInfo for first level (C calling Lua) */
    volatile lua_Hook hook;
    ptrdiff_t errfunc;  /* current error handling function (stack index) */
    int stacksize;
    int basehookcount;
    int hookcount;
    unsigned short nny;  /* number of non-yieldable calls in stack */
    unsigned short nCcalls;  /* number of nested C calls */
    l_signalT hookmask;
    lu_byte allowhook;
};


#define G(L)  (L->l_G)

/**
 * 所有可回收对象的联合体（仅用于类型转换）。
 * 包含 Lua 中各种可回收对象的结构体，通过共用头部 `GCObject` 实现统一管理。
 * 成员包括：
 *   - `gc`: 通用头部，用于垃圾回收。
 *   - `ts`: 字符串对象。
 *   - `u`: 用户数据对象。
 *   - `cl`: 闭包对象。
 *   - `h`: 表对象。
 *   - `p`: 函数原型对象。
 *   - `th`: 线程对象（协程）。
 */
/*
** Union of all collectable objects (only for conversions)
*/
union GCUnion {
    GCObject gc;  /* common header */
    struct TString ts;
    struct Udata u;
    union Closure cl;
    struct Table h;
    struct Proto p;
    struct lua_State th;  /* thread */
};


#define cast_u(o)  cast(union GCUnion *, (o))

/* macros to convert a GCObject into a specific value */
// 将 GCObject 转换为特定类型的值的宏定义

/**
 * @brief 将给定的 Lua 对象转换为字符串类型（LUA_TSTRING）。
 * @param o 指向 Lua 对象的指针。
 * @return 返回对象的字符串部分（`ts` 字段）。
 * @note 该宏会检查对象的类型是否为字符串类型，如果不是，则行为未定义。
 */
#define gco2ts(o) \
    check_exp(novariant((o)->tt) == LUA_TSTRING, &((cast_u(o))->ts))
/**
 * 将 Lua 对象转换为用户数据类型（userdata）的指针。
 * 该宏会检查对象的类型是否为 LUA_TUSERDATA，确保类型安全。
 * 如果类型检查通过，则返回指向用户数据的指针。
 *
 * @param o Lua 对象（必须是 userdata 类型）。
 * @return 指向用户数据的指针。
 */
#define gco2u(o) check_exp((o)->tt == LUA_TUSERDATA, &((cast_u(o))->u))
/**
 * @brief 将给定的对象转换为轻量级闭包（light C closure）。
 * @param o 指向Lua对象的指针，必须为轻量级闭包类型（LUA_TLCL）。
 * @return 返回指向轻量级闭包的指针。
 * @note 此宏会检查对象的类型是否为LUA_TLCL，如果不是则会触发断言。
 */
#define gco2lcl(o) check_exp((o)->tt == LUA_TLCL, &((cast_u(o))->cl.l))
/**
 * 将 Lua 对象转换为闭包对象（C Closure）。
 * 这是一个宏定义，用于类型检查和转换。
 *
 * @param o 指向 Lua 对象的指针。
 * @return 返回转换后的闭包对象指针。
 * @note 该宏会检查对象的类型是否为 LUA_TCCL（C 闭包类型），
 *       如果类型不匹配，会触发断言错误。
 */
#define gco2ccl(o) check_exp((o)->tt == LUA_TCCL, &((cast_u(o))->cl.c))
#define gco2cl(o) \
    check_exp(novariant((o)->tt) == LUA_TFUNCTION, &((cast_u(o))->cl))
#define gco2t(o)  check_exp((o)->tt == LUA_TTABLE, &((cast_u(o))->h))
#define gco2p(o)  check_exp((o)->tt == LUA_TPROTO, &((cast_u(o))->p))
#define gco2th(o)  check_exp((o)->tt == LUA_TTHREAD, &((cast_u(o))->th))

/**
 * 将 Lua 对象转换为 GCObject 的宏。
 * 该宏用于检查对象的类型是否为有效的 Lua 类型（非 LUA_TDEADKEY），
 * 并将其转换为 GCObject 指针。
 *
 * @param v 待转换的 Lua 对象。
 * @return 返回转换后的 GCObject 指针。
 */
/* macro to convert a Lua object into a GCObject */
#define obj2gco(v) \
    check_exp(novariant((v)->tt) < LUA_TDEADKEY, (&(cast_u(v)->gc)))

/* actual number of total bytes allocated */
#define gettotalbytes(g)  cast(lu_mem, (g)->totalbytes + (g)->GCdebt)

LUAI_FUNC void luaE_setdebt(global_State *g, l_mem debt);

LUAI_FUNC void luaE_freethread(lua_State *L, lua_State *L1);

LUAI_FUNC CallInfo *luaE_extendCI(lua_State *L);

LUAI_FUNC void luaE_freeCI(lua_State *L);

LUAI_FUNC void luaE_shrinkCI(lua_State *L);


#endif

